# Makefile for tests of the Citus extension

spq_subdir = src/test/regress
spq_top_builddir = ../../..

include $(spq_top_builddir)/Makefile.global

# ensure MAJORVERSION is defined (missing in older versions)
ifndef MAJORVERSION
MAJORVERSION := $(basename $(VERSION))
endif

# Add ./bin to $PATH so we use our custom diff instead of the default diff tool.
# We do this to be able to mask shard Ids, placement Ids, node ports, etc.
MAKEFILE_DIR := $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
export PATH := $(MAKEFILE_DIR)/bin:$(PATH)
export PG_REGRESS_DIFF_OPTS = -dU10 -w
# Use lower isolation test timeout, the 5 minute default is waaay too long for
# us so we use 60 seconds instead. We should detect blockages very quickly and
# most queries that we run are also very fast. So fast even that 60 seconds is
# usually too long. However, any commands involving logical replication can be
# quite slow, especially shard splits and especially on CI. So we still keep
# this value at the pretty high 60 seconds because even those slow commands are
# definitly stuck when they take longer than that.
export PGISOLATIONTIMEOUT = 60

##
## Spq regression support
##
MULTI_INSTALLDIR=$(CURDIR)/tmp_check/install
pg_regress_multi_check = $(PERL) $(spq_abs_srcdir)/pg_regress_multi.pl --pgxsdir="$(pgxsdir)" --bindir="$(bindir)" --libdir="$(libdir)" --majorversion="$(MAJORVERSION)" --postgres-builddir="$(postgres_abs_builddir)" --postgres-srcdir="$(postgres_abs_srcdir)" --spq_abs_srcdir="$(spq_abs_srcdir)"
ifdef PG_REGRESS_SINGLE
  pg_regress_multi_check += --pg-regress-single="$(PG_REGRESS_SINGLE)"
endif

MULTI_REGRESS_OPTS = --inputdir=$(spq_abs_srcdir) $(pg_regress_locale_flags)

pg_upgrade_check = $(spq_abs_srcdir)/citus_tests/upgrade/pg_upgrade_test.py
citus_upgrade_check =CITUS_OLD_VERSION=$(citus-old-version) $(spq_abs_srcdir)/citus_tests/upgrade/citus_upgrade_test.py
arbitrary_config_check = $(spq_abs_srcdir)/citus_tests/arbitrary_configs/citus_arbitrary_configs.py
query_generator_check = $(spq_abs_srcdir)/citus_tests/query_generator/bin/run_query_compare_test.py

template_isolation_files = $(shell find $(spq_abs_srcdir)/spec/ -name '*.spec')
generated_isolation_files = $(patsubst $(spq_abs_srcdir)/spec/%,$(spq_abs_srcdir)/build/specs/%,$(template_isolation_files))

vanilla_diffs_file = $(spq_abs_srcdir)/pg_vanilla_outputs/$(MAJORVERSION)/regression.diffs

# have make check actually run all tests, but keep check-full as an
# intermediate, for muscle memory backward compatibility.
check: check-full check-enterprise-full
# check-full triggers all tests that ought to be run routinely
check-full: check-multi check-multi-mx check-multi-1 check-operations check-follower-cluster check-isolation check-failure check-split check-vanilla check-pg-upgrade check-arbitrary-configs check-citus-upgrade check-citus-upgrade-mixed check-citus-upgrade-local check-citus-upgrade-mixed-local check-pytest check-query-generator check-spq
# check-enterprise-full triggers all enterprise specific tests
check-enterprise-full: check-enterprise check-enterprise-isolation check-enterprise-failure check-enterprise-isolation-logicalrep-1 check-enterprise-isolation-logicalrep-2 check-enterprise-isolation-logicalrep-3


ISOLATION_DEPDIR=.deps/isolation
ISOLATION_BUILDDIR=build/specs

# this can be used to print a value of variable
# ex: make print-generated_isolation_files
print-%  : ; @echo $* = $($*)

.PHONY: create-symbolic-link

create-symbolic-link:
	mkdir -p $(spq_abs_srcdir)/build
	ln -fsn $(spq_abs_srcdir)/expected $(spq_abs_srcdir)/build/

# How this target works:
# cpp is used before running isolation tests to preprocess spec files.
# This way we can include any file we want to. Currently this is used to include mx common part.
# spec files are put to /build/specs for clear separation between generated files and template files
# a symbolic link is created for /expected in build/expected/.
# when running isolation tests, as the inputdir, build is passed so
# it runs the spec files from build/specs and checks the expected output from build/expected.
# /specs is renamed as /spec because postgres first look at the specs file under current directory,
# so this is renamed to avoid that since we are running the isolation tests from build/specs now.
$(generated_isolation_files): $(spq_abs_srcdir)/build/specs/%: $(spq_abs_srcdir)/spec/% Makefile
	@mkdir -p $(spq_abs_srcdir)/$(ISOLATION_DEPDIR) $(spq_abs_srcdir)/$(ISOLATION_BUILDDIR)
	@# -MF is used to store dependency files(.Po) in another directory for separation
	@# -MT is used to change the target of the rule emitted by dependency generation.
	@# -P is used to inhibit generation of linemarkers in the output from the preprocessor.
	@# -undef is used to not predefine any system-specific or GCC-specific macros.
	@# `man cpp` for further information
	@# sed is used to strip the final // comments, because OSX cpp is weird
	cd $(spq_abs_srcdir) && cpp -undef -w -P -MMD -MP -MF$(ISOLATION_DEPDIR)/$(*F).Po -MT$@ $< | sed '/^\/\//d' | sed '/^$$/d' > $@


Isolation_Po_files := $(wildcard $(ISOLATION_DEPDIR)/*.Po)
ifneq (,$(Isolation_Po_files))
include $(Isolation_Po_files)
endif

isolation_test_files=$(generated_isolation_files) create-symbolic-link

ifndef CITUS_VALGRIND_LOG_FILE
CITUS_VALGRIND_LOG_FILE := citus_valgrind_test_log.txt
endif

# check-base only sets up a testing environment so you can specify all your tests using EXTRA_TESTS
check-base: all
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/base_schedule $(EXTRA_TESTS)

# check-minimal only sets up the cluster
check-minimal: all
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/minimal_schedule $(EXTRA_TESTS)

check-base-vg: all
	$(pg_regress_multi_check) --load-extension=spq \
	--valgrind --pg_ctl-timeout=360 --connection-timeout=500000 --valgrind-path=valgrind --valgrind-log-file=$(CITUS_VALGRIND_LOG_FILE) \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/base_schedule $(EXTRA_TESTS)

check-base-mx: all
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/mx_base_schedule $(EXTRA_TESTS)

check-minimal-mx: all
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/mx_minimal_schedule $(EXTRA_TESTS)

check-custom-schedule: all
	$(pg_regress_multi_check) --load-extension=spq --worker-count=$(WORKERCOUNT) \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/$(SCHEDULE) $(EXTRA_TESTS)

check-failure-custom-schedule: all
	$(pg_regress_multi_check) --load-extension=spq --mitmproxy --worker-count=$(WORKERCOUNT) \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/$(SCHEDULE) $(EXTRA_TESTS)

check-isolation-custom-schedule: all  $(isolation_test_files)
	$(pg_regress_multi_check) --load-extension=spq --isolationtester --worker-count=$(WORKERCOUNT) \
	-- $(MULTI_REGRESS_OPTS) --inputdir=$(spq_abs_srcdir)/build --schedule=$(spq_abs_srcdir)/$(SCHEDULE) $(EXTRA_TESTS)

check-custom-schedule-vg: all
	$(pg_regress_multi_check) --load-extension=spq \
	--valgrind --pg_ctl-timeout=360 --connection-timeout=500000 --worker-count=$(WORKERCOUNT) \
	--valgrind-path=valgrind --valgrind-log-file=$(CITUS_VALGRIND_LOG_FILE) \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/$(SCHEDULE) $(EXTRA_TESTS)

check-failure-custom-schedule-vg: all
	$(pg_regress_multi_check) --load-extension=spq --mitmproxy \
	--valgrind --pg_ctl-timeout=360 --connection-timeout=500000 --worker-count=$(WORKERCOUNT) \
	--valgrind-path=valgrind --valgrind-log-file=$(CITUS_VALGRIND_LOG_FILE) \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/$(SCHEDULE) $(EXTRA_TESTS)

check-isolation-custom-schedule-vg: all  $(isolation_test_files)
	$(pg_regress_multi_check) --load-extension=spq --isolationtester --worker-count=$(WORKERCOUNT) \
	--valgrind --pg_ctl-timeout=360 --connection-timeout=500000 --valgrind-path=valgrind --valgrind-log-file=$(CITUS_VALGRIND_LOG_FILE) \
	-- $(MULTI_REGRESS_OPTS) --inputdir=$(spq_abs_srcdir)/build --schedule=$(spq_abs_srcdir)/$(SCHEDULE) $(EXTRA_TESTS)


check-empty: all
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) $(EXTRA_TESTS)

check-spq: all
	@cp -rf $(spq_abs_srcdir)/data $(spq_top_builddir)/$(spq_subdir)/
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/spq_schedule $(EXTRA_TESTS)

check-multi: all
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/multi_schedule $(EXTRA_TESTS)

check-enterprise: all
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/enterprise_schedule $(EXTRA_TESTS)
check-multi-1: all
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/multi_1_schedule $(EXTRA_TESTS)

check-multi-hyperscale: all
	$(pg_regress_multi_check) --conninfo="$(conninfo)" --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/multi_schedule_hyperscale $(EXTRA_TESTS)

check-multi-hyperscale-superuser: all
	$(pg_regress_multi_check) --conninfo="$(conninfo)" --worker-1-public-hostname="$(worker_1_public_hostname)" --worker-2-public-hostname="$(worker_2_public_hostname)" --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/multi_schedule_hyperscale_superuser $(EXTRA_TESTS)

check-multi-vg: all
	$(pg_regress_multi_check) --load-extension=spq --valgrind \
	--pg_ctl-timeout=360 --connection-timeout=500000 --valgrind-path=valgrind --valgrind-log-file=$(CITUS_VALGRIND_LOG_FILE) \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/multi_schedule $(EXTRA_TESTS)

check-multi-1-vg: all
	$(pg_regress_multi_check) --load-extension=spq --valgrind \
	--pg_ctl-timeout=360 --connection-timeout=500000 --valgrind-path=valgrind --valgrind-log-file=$(CITUS_VALGRIND_LOG_FILE) \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/multi_1_schedule $(EXTRA_TESTS)

check-columnar-vg: all
	$(pg_regress_multi_check) --load-extension=spq --valgrind \
	--pg_ctl-timeout=360 --connection-timeout=500000 --valgrind-path=valgrind --valgrind-log-file=$(CITUS_VALGRIND_LOG_FILE) \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/columnar_schedule $(EXTRA_TESTS)

check-isolation: all  $(isolation_test_files)
	$(pg_regress_multi_check) --load-extension=spq --isolationtester \
	-- $(MULTI_REGRESS_OPTS) --inputdir=$(spq_abs_srcdir)/build --schedule=$(spq_abs_srcdir)/isolation_schedule $(EXTRA_TESTS)

check-enterprise-isolation: all $(isolation_test_files)
	$(pg_regress_multi_check) --load-extension=spq --isolationtester \
	-- $(MULTI_REGRESS_OPTS) --inputdir=$(spq_abs_srcdir)/build --schedule=$(spq_abs_srcdir)/enterprise_isolation_schedule $(EXTRA_TESTS)

# we have separate targets for logical replication tests because they take very long to complete
# hence this increases parallelism a lot without sacrifing any coverage.
check-enterprise-isolation-logicalrep-1: all $(isolation_test_files)
	$(pg_regress_multi_check) --load-extension=spq --isolationtester \
	-- $(MULTI_REGRESS_OPTS) --inputdir=$(spq_abs_srcdir)/build --schedule=$(spq_abs_srcdir)/enterprise_isolation_logicalrep_1_schedule $(EXTRA_TESTS)

check-enterprise-isolation-logicalrep-2: all $(isolation_test_files)
	$(pg_regress_multi_check) --load-extension=spq --isolationtester \
	-- $(MULTI_REGRESS_OPTS) --inputdir=$(spq_abs_srcdir)/build --schedule=$(spq_abs_srcdir)/enterprise_isolation_logicalrep_2_schedule $(EXTRA_TESTS)

check-enterprise-isolation-logicalrep-3: all $(isolation_test_files)
	$(pg_regress_multi_check) --load-extension=spq --isolationtester \
	-- $(MULTI_REGRESS_OPTS) --inputdir=$(spq_abs_srcdir)/build --schedule=$(spq_abs_srcdir)/enterprise_isolation_logicalrep_3_schedule $(EXTRA_TESTS)

check-isolation-base: all  $(isolation_test_files)
	$(pg_regress_multi_check) --load-extension=spq --isolationtester \
	-- $(MULTI_REGRESS_OPTS) --inputdir=$(spq_abs_srcdir)/build --schedule=$(spq_abs_srcdir)/base_isolation_schedule $(EXTRA_TESTS)

# ci takes regression.diffs output from another location, so copy diffs file at the end.
check-vanilla: all
	$(pg_regress_multi_check) --vanillatest || (cp $(vanilla_diffs_file) $(spq_abs_srcdir)/regression.diffs && false)

check-multi-mx: all
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/multi_mx_schedule $(EXTRA_TESTS)

check-follower-cluster: all
	$(pg_regress_multi_check) --load-extension=spq --follower-cluster \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/multi_follower_schedule $(EXTRA_TESTS)

check-operations: all
	$(pg_regress_multi_check) --load-extension=spq  --worker-count=6 \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/operations_schedule $(EXTRA_TESTS)

check-split: all
	$(pg_regress_multi_check) --load-extension=spq \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/split_schedule $(EXTRA_TESTS)

check-failure: all
	$(pg_regress_multi_check) --load-extension=spq --mitmproxy \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/failure_schedule $(EXTRA_TESTS)

check-failure-base: all
	$(pg_regress_multi_check) --load-extension=spq --mitmproxy \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/failure_base_schedule $(EXTRA_TESTS)

check-enterprise-failure: all
	$(pg_regress_multi_check) --load-extension=spq --mitmproxy \
	-- $(MULTI_REGRESS_OPTS) --schedule=$(spq_abs_srcdir)/enterprise_failure_schedule $(EXTRA_TESTS)

check-pg-upgrade: all
	$(pg_upgrade_check) --old-bindir=$(old-bindir) --new-bindir=$(new-bindir) --pgxsdir=$(pgxsdir)

check-arbitrary-configs: all
	${arbitrary_config_check} --bindir=$(bindir) --pgxsdir=$(pgxsdir) --parallel=$(parallel) --configs=$(CONFIGS) --seed=$(seed)

check-arbitrary-base: all
	${arbitrary_config_check} --bindir=$(bindir) --pgxsdir=$(pgxsdir) --parallel=$(parallel) --configs=$(CONFIGS) --seed=$(seed) --base

check-pytest:
	pytest -n auto

check-query-generator: all
	${query_generator_check} --bindir=$(bindir) --pgxsdir=$(pgxsdir) --seed=$(seed)

check-citus-upgrade: all
	$(citus_upgrade_check) \
		--bindir=$(bindir) \
		--pgxsdir=$(pgxsdir) \
		--citus-pre-tar=$(citus-pre-tar) \
		--citus-post-tar=$(citus-post-tar)

check-citus-upgrade-mixed: all
	$(citus_upgrade_check) \
		--bindir=$(bindir) \
		--pgxsdir=$(pgxsdir) \
		--citus-pre-tar=$(citus-pre-tar) \
		--citus-post-tar=$(citus-post-tar) \
		--mixed

check-citus-upgrade-local: all clean-upgrade-artifacts
	$(citus_upgrade_check) \
		--bindir=$(bindir) \
		--pgxsdir=$(pgxsdir) \
		--citus-old-version=$(citus-old-version)

check-citus-upgrade-mixed-local: all clean-upgrade-artifacts
	$(citus_upgrade_check) \
		--bindir=$(bindir) \
		--pgxsdir=$(pgxsdir) \
		--citus-old-version=$(citus-old-version) \
		--mixed

clean-upgrade-artifacts:
	rm -rf $(spq_abs_srcdir)/tmp_citus_upgrade/ /tmp/citus_copy/

clean distclean maintainer-clean:
	rm -rf input/ output/
	rm -rf tmp_check/
	rm -rf tmp_citus_test/

